/*
 * TransactionalSet.java   ver    14 Nov 2009
 * 
 * Copyright (c) 2009 mentalsmash.org
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The use of the Apache License does not indicate that this project is
 * affiliated with the Apache Software Foundation.
 */
package org.mentalsmash.tazio.transactions.model;

import java.io.Serializable;
import java.util.Set;

/**
 * @author Andrea Reale
 * @version 0.0.1
 * 
 */
public interface TransactionalSet extends TransactionalObject,
	Set<Serializable> {

    /**
     * Returns <code>true</code> if the <tt>TransactionalSet</tt> is a set of
     * primitive instances. <code>false</code> if it is a set of Transactional
     * objects.
     * 
     * @return Returns <code>true</code> if the <tt>TransactionalSet</tt> is a
     *         set of primitive instances. <code>false</code> if it is a set of
     *         Transactional objects.
     */
    boolean containsPrimitives();

    /**
     * Adds an object to the transactional set, outside the context of any
     * transaction
     * 
     * @param obj
     *            the object to add to the set.
     */
    void doAdd(Serializable obj);

    /**
     * Removes an object from the transactional set, outsied the context of any
     * transaction
     * 
     * @param toRemove
     *            the object to remove
     * @return the removed object or <code>null</code> if nothing was removed
     */
    Serializable doRemove(Serializable toRemove);
}
